/*
 * Copyright 2008 Max Kugland
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.splink.resource {
	import org.splink.library.distributor.Devent;
	import org.splink.library.distributor.Dtype;
	import org.splink.library.distributor.IDistributor;

	/**
	 * The event is distributed when the loading of resources progresses and grants access to a
	 * <code>ResourceProgress</code> instance which contains detailed information about the load
	 * progress of the current resource and the overall load progress.
	 *
	 * @see org.splink.resource.ResourceProgress
	 * 
	 * @author Max Kugland
	 */
	public class ResourceProcessorEvent extends Devent {
		public static const PROGRESS : Dtype = new Dtype("progress");
		private var _resourceProgress : ResourceProgress;

		public function ResourceProcessorEvent(source : IDistributor, type : Dtype, resourceProgress : ResourceProgress) {
			super(source, type);
			
			_resourceProgress = resourceProgress;
		}

		/**
		 * @return a <code>ResourceProgress</code> object which contains detailed information about the
		 * progress of the current and overall resource loading
		 * 
		 * @see ResourceProgress
		 */
		public function get resourceProgress() : ResourceProgress {
			return _resourceProgress;
		}
		
		public function clone(source : IDistributor) :ResourceProcessorEvent {
			return new ResourceProcessorEvent(source, type, resourceProgress);
		}
	}
}
